<!doctype html>
<html lang=en>
<head>
<meta charset=utf-8>
<title>Link</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.10.1/css/all.min.css" integrity="sha512-9my9Mb2+0YO+I4PUCSwUYO7sEK21Y0STBAiFEYoWtd2VzLEZZ4QARDrZ30hdM1GlioHJ8o8cWQiy8IAb1hy/Hg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<style>@import "dist/ourbigbook.css";

</style>
<link rel="stylesheet" type="text/css" href="main.css">
</head>
<body>
<header>
<a href="/">Ciro Santilli???</a>
<a href=".">Ourbigbook!!!</a>
<a class="font-awesome-container" href="https://github.com/cirosantilli/ourbigbook"><i class="fab fa-github fa-fw"></i></a>
</header>
<main class="ourbigbook">
<div><span class="hide-hover"><a href=".#link"><span class="fa-solid-900"></span></a></span><div class="h" id="link"><h1><a href="" title="link to this element">Link (<code>\a</code>)</a></h1>
<span class="hover-meta"> <span class="sep"></span><a title="view all headers in a single page" href=".#link"><span class="fa-solid-900"></span> nosplit</a><span class="sep"></span><a href=".#macro" title="parent header"><span class="fa-solid-900"></span> "Macro"</a><span class="sep"></span><span class="metrics"><span title="word count for this node + all descendants"><span class="fa-regular-400"></span> words: <span class="word-count-descendant">1k</span></span></span></span></div><nav class="h-nav h-nav-toplevel"><div class="nav"> <span title="tags" class="fa-solid-900"></span> tags: <a href=".#macros-with-insane-shortcut" title="internal link
word count: 3
descendant word count: 363
descendant count: 33">Macros with insane shortcut</a></div><div class="nav"> <a href=".#macro" title="parent header"><span class="fa-solid-900"></span> "Macro"</a><span class="sep"></span><a title="view all headers in a single page" href=".#link"><span class="fa-solid-900"></span> nosplit</a><span class="sep"></span><a href="#toc"><span class="fa-solid-900"></span> toc</a><span class="sep"></span><span class="metrics"><span title="word count for this node + all descendants"><span class="fa-regular-400"></span> words: <span class="word-count-descendant">1k</span></span></span></div></nav>
</div><div><span class="hide-hover"><a href=".#link"><span class="fa-solid-900"></span></a></span></div><div><span class="hide-hover"><a href="#_273"><span class="fa-solid-900"></span></a></span><div class="p" id="_273"><a href=".#insane-macro-shortcuts" title="internal link
word count: 4
descendant word count: 427
descendant count: 64">Insane</a> autolink (link text is the same as the link):
<div class="code" id="_274">
<pre><code>The website http://example.com is cool. See also:

\Q[http://example.com/2]
</code></pre></div><div class="p" id="_275">which renders as:</div><blockquote id="_276"><div class="p" id="_277">The website <a href="http://example.com">http://example.com</a> is cool. See also:</div><blockquote id="_278"><a href="http://example.com/2">http://example.com/2</a></blockquote></blockquote>
Exact parsing rules described at: <a href=".#insane-link-parsing-rules" title="internal link
word count: 0
descendant word count: 248
descendant count: 248">Section 5. "Insane link parsing rules"</a>.</div></div><div><span class="hide-hover"><a href="#_279"><span class="fa-solid-900"></span></a></span><div class="p" id="_279">Equivalent sane version:
<div class="code" id="_280">
<pre><code>The website \a[http://example.com] is cool.

\Q[\a[http://example.com/2]]
</code></pre></div><div class="p" id="_281">which renders as:</div><blockquote id="_282"><div class="p" id="_283">The website <a href="http://example.com">http://example.com</a> is cool.</div><blockquote id="_284"><a href="http://example.com/2">http://example.com/2</a></blockquote></blockquote></div></div><div><span class="hide-hover"><a href="#_285"><span class="fa-solid-900"></span></a></span><div class="p" id="_285">Insane link with custom text:
<div class="code" id="_286">
<pre><code>The website http://example.com[example.com] is cool.
</code></pre></div><div class="p" id="_287">which renders as:</div><blockquote id="_288"><div class="p" id="_289">The website <a href="http://example.com">example.com</a> is cool.</div></blockquote>
Equivalent sane version:
<div class="code" id="_290">
<pre><code>The website \a[http://example.com][example.com] is cool.
</code></pre></div><div class="p" id="_291">which renders as:</div><blockquote id="_292"><div class="p" id="_293">The website <a href="http://example.com">example.com</a> is cool.</div></blockquote>
If the custom text is empty, an autolink is generated. This is often useful if you want your link to be followed by punctuation:
<div class="code" id="_294">
<pre><code>The website is really cool: http://example.com[].
</code></pre></div><div class="p" id="_295">which renders as:</div><blockquote id="_296"><div class="p" id="_297">The website is really cool: <a href="http://example.com">http://example.com</a>.</div></blockquote>
This could also be achieved with the sane syntax of course, but this pattern saves a tiny bit of typing.</div></div><div><span class="hide-hover"><a href="#_298"><span class="fa-solid-900"></span></a></span><div class="p" id="_298">Link with multiple paragraphs inside it:
<div class="code" id="_299">
<pre><code>\a[http://example.com][Multiple

paragraphs]
</code></pre></div><div class="p" id="_300">which renders as:</div><blockquote id="_301"><div class="p" id="_302"><a href="http://example.com"><div class="p" id="_303">Multiple</div><div class="p" id="_304">paragraphs</div></a></div></blockquote></div></div><div><span class="hide-hover"><a href="#toc"><span class="fa-solid-900"></span></a></span><div id="toc"class="toc-container">
<ul>
<li class="has-child toplevel"><div class="title-div"><div class="arrow"><div></div></div><span class="not-arrow"><a class="title" href="#toc">Table of contents</a><span class="hover-metadata"><span class="metrics-sep"><span class="sep"></span><span class="metrics"><span title="word count for this node + all descendants"><span class="fa-regular-400"></span> <span class="word-count-descendant">1k</span></span></span></span></span></span></div>
<ul>
<li><div id="toc-a-check-argument"><div class="arrow"><div></div></div><span class="not-arrow"><a href="a-check-argument">1. <code>\a</code> <code>check</code> argument</a><span class="hover-metadata"><span class="sep"></span><a href="#toc-a-check-argument" title="link to this ToC entry"><span class="fa-solid-900"></span> link</a><span class="sep"></span><a title="view all headers in a single page" href=".#a-check-argument"><span class="fa-solid-900"></span> nosplit</a><span class="sep"></span><a href="#toc" title="parent ToC entry"><span class="fa-solid-900"></span> "Link"</a><span class="metrics-sep"><span class="sep"></span><span class="metrics"><span title="word count for this node"><span class="fa-regular-400"></span> <span class="word-count">264</span></span></span></span></span></span></div></li>
<li><div id="toc-a-href-argument"><div class="arrow"><div></div></div><span class="not-arrow"><a href="a-href-argument">2. <code>\a</code> <code>href</code> argument</a><span class="hover-metadata"><span class="sep"></span><a href="#toc-a-href-argument" title="link to this ToC entry"><span class="fa-solid-900"></span> link</a><span class="sep"></span><a title="view all headers in a single page" href=".#a-href-argument"><span class="fa-solid-900"></span> nosplit</a><span class="sep"></span><a href="#toc" title="parent ToC entry"><span class="fa-solid-900"></span> "Link"</a><span class="metrics-sep"><span class="sep"></span><span class="metrics"><span title="word count for this node"><span class="fa-regular-400"></span> <span class="word-count">37</span></span></span></span></span></span></div></li>
<li><div id="toc-a-ref-argument"><div class="arrow"><div></div></div><span class="not-arrow"><a href="a-ref-argument">3. <code>\a</code> <code>ref</code> argument</a><span class="hover-metadata"><span class="sep"></span><a href="#toc-a-ref-argument" title="link to this ToC entry"><span class="fa-solid-900"></span> link</a><span class="sep"></span><a title="view all headers in a single page" href=".#a-ref-argument"><span class="fa-solid-900"></span> nosplit</a><span class="sep"></span><a href="#toc" title="parent ToC entry"><span class="fa-solid-900"></span> "Link"</a><span class="metrics-sep"><span class="sep"></span><span class="metrics"><span title="word count for this node"><span class="fa-regular-400"></span> <span class="word-count">30</span></span></span></span></span></span></div></li>
<li class="has-child"><div id="toc-a-relative-argument"><div class="arrow"><div></div></div><span class="not-arrow"><a href="a-relative-argument">4. <code>\a</code> <code>relative</code> argument</a><span class="hover-metadata"><span class="sep"></span><a href="#toc-a-relative-argument" title="link to this ToC entry"><span class="fa-solid-900"></span> link</a><span class="sep"></span><a title="view all headers in a single page" href=".#a-relative-argument"><span class="fa-solid-900"></span> nosplit</a><span class="sep"></span><a href="#toc" title="parent ToC entry"><span class="fa-solid-900"></span> "Link"</a><span class="metrics-sep"><span class="sep"></span><span class="metrics"><span title="word count for this node"><span class="fa-regular-400"></span> <span class="word-count">27</span></span></span></span></span></span></div>
<ul>
<li class="has-child"><div id="toc-relative-link"><div class="arrow"><div></div></div><span class="not-arrow"><a href="relative-link">4.1. Relative link</a><span class="hover-metadata"><span class="sep"></span><a href="#toc-relative-link" title="link to this ToC entry"><span class="fa-solid-900"></span> link</a><span class="sep"></span><a title="view all headers in a single page" href=".#relative-link"><span class="fa-solid-900"></span> nosplit</a><span class="sep"></span><a href="#toc-a-relative-argument" title="parent ToC entry"><span class="fa-solid-900"></span> "<code>\a</code> <code>relative</code> argument"</a><span class="metrics-sep"><span class="sep"></span><span class="metrics"><span title="word count for this node"><span class="fa-regular-400"></span> <span class="word-count">239</span></span></span></span></span></span></div>
<ul>
<li><div id="toc-url-with-protocol"><div class="arrow"><div></div></div><span class="not-arrow"><a href="url-with-protocol">4.1.1. URL with protocol</a><span class="hover-metadata"><span class="sep"></span><a href="#toc-url-with-protocol" title="link to this ToC entry"><span class="fa-solid-900"></span> link</a><span class="sep"></span><a title="view all headers in a single page" href=".#url-with-protocol"><span class="fa-solid-900"></span> nosplit</a><span class="sep"></span><a href="#toc-relative-link" title="parent ToC entry"><span class="fa-solid-900"></span> "Relative link"</a><span class="metrics-sep"><span class="sep"></span><span class="metrics"><span title="word count for this node"><span class="fa-regular-400"></span> <span class="word-count">92</span></span></span></span></span></span></div></li>
</ul>
</li>
</ul>
<li><div id="toc-insane-link-parsing-rules"><div class="arrow"><div></div></div><span class="not-arrow"><a href="insane-link-parsing-rules">5. Insane link parsing rules</a><span class="hover-metadata"><span class="sep"></span><a href="#toc-insane-link-parsing-rules" title="link to this ToC entry"><span class="fa-solid-900"></span> link</a><span class="sep"></span><a title="view all headers in a single page" href=".#insane-link-parsing-rules"><span class="fa-solid-900"></span> nosplit</a><span class="sep"></span><a href="#toc" title="parent ToC entry"><span class="fa-solid-900"></span> "Link"</a><span class="metrics-sep"><span class="sep"></span><span class="metrics"><span title="word count for this node"><span class="fa-regular-400"></span> <span class="word-count">248</span></span></span></span></span></span></div></li>
</ul>
</li>
</ul>
</div>
</div><div><span class="hide-hover"><a href="#ancestors"><span class="fa-solid-900"></span></a></span><h2 id="#ancestors"><a href="#ancestors">Ancestors</a></h2></div>
<div><ul>
<li><a href=".#macro" title="internal link
word count: 155
descendant word count: 14k
descendant count: 14">Macro</a></li>
<li><a href="." title="internal link
word count: 296
descendant word count: 32k
descendant count: 234">OurBigBook</a></li>
</ul></div><div><span class="hide-hover"><a href="#incoming-links"><span class="fa-solid-900"></span></a></span><h2 id="incoming-links"><a href="#incoming-links">Incoming links</a></h2></div>
<div><ul>
<li><a href=".#block-vs-inline-macros" title="internal link
word count: 0
descendant word count: 77
descendant count: 77">Block vs inline macros</a></li>
<li><a href=".#internal-cross-reference" title="internal link
word count: 28
descendant word count: 2k
descendant count: 98">Internal cross reference</a></li>
<li><a href=".#internal-cross-reference-title-link-removal" title="internal link
word count: 0
descendant word count: 123
descendant count: 123">Internal cross reference title link removal</a></li>
<li><a href=".#macros-with-insane-shortcut" title="internal link
word count: 3
descendant word count: 363
descendant count: 33">Macros with insane shortcut</a></li>
<li><a href=".#positional-argument-default-values" title="internal link
word count: 0
descendant word count: 82
descendant count: 82">Positional argument default values</a></li>
</ul></div></main>
<footer>
<div>License: <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a> unless noted</div>
<div>Website source code: <a href="https://github.com/cirosantilli/ourbigbook">https://github.com/cirosantilli/ourbigbook</a></div>
<div>Website Git version: <a href="https://github.com/cirosantilli/ourbigbook/commit/72b4ad0343402d4c826196c7d9bc27ae17c31e1d">72b4ad0343402d4c826196c7d9bc27ae17c31e1d</a></div>
</footer>
<script>
<!-- Google Analytics, AKA selling my soul to Google for some backlinks. -->
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-47867706-1', 'auto');
ga('send', 'pageview');
</script>
<script src="dist/ourbigbook_runtime.js"></script>
<script>ourbigbook_runtime.ourbigbook_runtime()</script>
</body>
</html>
